Developer CD Series 1999 July: Mac OS SDK/Dev.CD Jul 99 SDK1.toast/Development Kits/Mac OS/Interfaces&Libraries/Universal/Interfaces/AIncludes/UnicodeConverter.a

Text File | 1998-08-17 | 12.4 KB | 341 lines | [TEXT/MPS ]

;
;    File:        UnicodeConverter.a
;
;    Contains:    Types, constants, and prototypes for Unicode Converter
;
;    Version:    Technology:    Mac OS 8
;                Release:    Universal Interfaces 3.2
;
;    Copyright:    © 1994-1998 by Apple Computer, Inc., all rights reserved.
;
;    Bugs?:        For bug reports, consult the following page on
;                the World Wide Web:
;
;                    http://developer.apple.com/bugreporter/
;
;
    IF &TYPE('__UNICODECONVERTER__') = 'UNDEFINED' THEN
__UNICODECONVERTER__ SET 1

    IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
    include 'MacTypes.a'
    ENDIF
    IF &TYPE('__TEXTCOMMON__') = 'UNDEFINED' THEN
    include 'TextCommon.a'
    ENDIF
    IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
    include 'MixedMode.a'
    ENDIF

;  Unicode conversion contexts:






;  UnicodeMapVersion type & values
; typedef SInt32                         UnicodeMapVersion


kUnicodeUseLatestMapping        EQU        -1
kUnicodeUseHFSPlusMapping        EQU        4
;  Types used in conversion
UnicodeMapping            RECORD 0
unicodeEncoding             ds.l    1                ; offset: $0 (0)
otherEncoding             ds.l    1                ; offset: $4 (4)
mappingVersion             ds.l    1                ; offset: $8 (8)
sizeof                     EQU *                    ; size:   $C (12)
                        ENDR
; typedef struct UnicodeMapping *        UnicodeMappingPtr

; typedef const struct UnicodeMapping *    ConstUnicodeMappingPtr

;  Control flags for ConvertFromUnicodeToText and ConvertFromTextToUnicode

kUnicodeUseFallbacksBit            EQU        0
kUnicodeKeepInfoBit                EQU        1
kUnicodeDirectionalityBits        EQU        2
kUnicodeVerticalFormBit            EQU        4
kUnicodeLooseMappingsBit        EQU        5
kUnicodeStringUnterminatedBit    EQU        6
kUnicodeTextRunBit                EQU        7
kUnicodeKeepSameEncodingBit        EQU        8
kUnicodeForceASCIIRangeBit        EQU        9
kUnicodeNoHalfwidthCharsBit        EQU        10

kUnicodeUseFallbacksMask        EQU        $00000001
kUnicodeKeepInfoMask            EQU        $00000002
kUnicodeDirectionalityMask        EQU        $0000000C
kUnicodeVerticalFormMask        EQU        $00000010
kUnicodeLooseMappingsMask        EQU        $00000020
kUnicodeStringUnterminatedMask    EQU        $00000040
kUnicodeTextRunMask                EQU        $00000080
kUnicodeKeepSameEncodingMask    EQU        $00000100
kUnicodeForceASCIIRangeMask        EQU        $00000200
kUnicodeNoHalfwidthCharsMask    EQU        $00000400
;  Values for kUnicodeDirectionality field

kUnicodeDefaultDirection        EQU        0
kUnicodeLeftToRight                EQU        1
kUnicodeRightToLeft                EQU        2
;  Directionality masks for control flags

kUnicodeDefaultDirectionMask    EQU        $00
kUnicodeLeftToRightMask            EQU        $04
kUnicodeRightToLeftMask            EQU        $08
;  Control flags for TruncateForUnicodeToText:

;   Now TruncateForUnicodeToText uses control flags from the same set as used by
;   ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc., but only
;   kUnicodeStringUnterminatedMask is meaningful for TruncateForUnicodeToText.
;
;   Previously two special control flags were defined for TruncateForUnicodeToText:
;          kUnicodeTextElementSafeBit = 0
;          kUnicodeRestartSafeBit = 1
;   However, neither of these was implemented.
;   Instead of implementing kUnicodeTextElementSafeBit, we now use
;   kUnicodeStringUnterminatedMask since it accomplishes the same thing and avoids
;   having special flags just for TruncateForUnicodeToText
;   Also, kUnicodeRestartSafeBit is unnecessary, since restart-safeness is handled by
;   setting kUnicodeKeepInfoBit with ConvertFromUnicodeToText.
;   If TruncateForUnicodeToText is called with one or both of the old special control
;   flags set (bits 0 or 1), it will not generate a paramErr, but the old bits have no
;   effect on its operation.



;  Filter bits for filter field in QueryUnicodeMappings and CountUnicodeMappings:

kUnicodeMatchUnicodeBaseBit        EQU        0
kUnicodeMatchUnicodeVariantBit    EQU        1
kUnicodeMatchUnicodeFormatBit    EQU        2
kUnicodeMatchOtherBaseBit        EQU        3
kUnicodeMatchOtherVariantBit    EQU        4
kUnicodeMatchOtherFormatBit        EQU        5

kUnicodeMatchUnicodeBaseMask    EQU        $00000001
kUnicodeMatchUnicodeVariantMask    EQU        $00000002
kUnicodeMatchUnicodeFormatMask    EQU        $00000004
kUnicodeMatchOtherBaseMask        EQU        $00000008
kUnicodeMatchOtherVariantMask    EQU        $00000010
kUnicodeMatchOtherFormatMask    EQU        $00000020
;  Control flags for SetFallbackUnicodeToText

kUnicodeFallbackSequencingBits    EQU        0

kUnicodeFallbackSequencingMask    EQU        $00000003
;  values for kUnicodeFallbackSequencing field

kUnicodeFallbackDefaultOnly        EQU        0
kUnicodeFallbackCustomOnly        EQU        1
kUnicodeFallbackDefaultFirst    EQU        2
kUnicodeFallbackCustomFirst        EQU        3

;  Caller-supplied entry point to a fallback handler
;  Function prototypes
    IF GENERATING68K ** ¬ GENERATINGCFM THEN

;      Routine to Initialize the Unicode Converter and cleanup once done with it.
;      These routines must be called from Static Library clients.


;
; pascal OSStatus InitializeUnicodeConverter(StringPtr TECFileName)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION InitializeUnicodeConverter
    ENDIF

;
; pascal void TerminateUnicodeConverter(void )
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION TerminateUnicodeConverter
    ENDIF

;  Note: the old names (InitializeUnicode, TerminateUnicode) for the above are still exported.
    ENDIF
;
; pascal OSStatus CreateTextToUnicodeInfo(ConstUnicodeMappingPtr iUnicodeMapping, TextToUnicodeInfo *oTextToUnicodeInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateTextToUnicodeInfo
    ENDIF

;
; pascal OSStatus CreateTextToUnicodeInfoByEncoding(TextEncoding iEncoding, TextToUnicodeInfo *oTextToUnicodeInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateTextToUnicodeInfoByEncoding
    ENDIF

;
; pascal OSStatus CreateUnicodeToTextInfo(ConstUnicodeMappingPtr iUnicodeMapping, UnicodeToTextInfo *oUnicodeToTextInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateUnicodeToTextInfo
    ENDIF

;
; pascal OSStatus CreateUnicodeToTextInfoByEncoding(TextEncoding iEncoding, UnicodeToTextInfo *oUnicodeToTextInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateUnicodeToTextInfoByEncoding
    ENDIF

;
; pascal OSStatus CreateUnicodeToTextRunInfo(ItemCount iNumberOfMappings, const UnicodeMapping iUnicodeMappings[2147483647], UnicodeToTextRunInfo *oUnicodeToTextInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateUnicodeToTextRunInfo
    ENDIF

;
; pascal OSStatus CreateUnicodeToTextRunInfoByEncoding(ItemCount iNumberOfEncodings, const TextEncoding iEncodings[2147483647], UnicodeToTextRunInfo *oUnicodeToTextInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateUnicodeToTextRunInfoByEncoding
    ENDIF

;
; pascal OSStatus CreateUnicodeToTextRunInfoByScriptCode(ItemCount iNumberOfScriptCodes, const ScriptCode iScripts[2147483647], UnicodeToTextRunInfo *oUnicodeToTextInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CreateUnicodeToTextRunInfoByScriptCode
    ENDIF

;  Change the TextToUnicodeInfo to another mapping.
;
; pascal OSStatus ChangeTextToUnicodeInfo(TextToUnicodeInfo ioTextToUnicodeInfo, ConstUnicodeMappingPtr iUnicodeMapping)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ChangeTextToUnicodeInfo
    ENDIF

;  Change the UnicodeToTextInfo to another mapping.
;
; pascal OSStatus ChangeUnicodeToTextInfo(UnicodeToTextInfo ioUnicodeToTextInfo, ConstUnicodeMappingPtr iUnicodeMapping)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ChangeUnicodeToTextInfo
    ENDIF


;
; pascal OSStatus DisposeTextToUnicodeInfo(TextToUnicodeInfo *ioTextToUnicodeInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION DisposeTextToUnicodeInfo
    ENDIF

;
; pascal OSStatus DisposeUnicodeToTextInfo(UnicodeToTextInfo *ioUnicodeToTextInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION DisposeUnicodeToTextInfo
    ENDIF

;
; pascal OSStatus DisposeUnicodeToTextRunInfo(UnicodeToTextRunInfo *ioUnicodeToTextRunInfo)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION DisposeUnicodeToTextRunInfo
    ENDIF

;
; pascal OSStatus ConvertFromTextToUnicode(TextToUnicodeInfo iTextToUnicodeInfo, ByteCount iSourceLen, ConstLogicalAddress iSourceStr, OptionBits iControlFlags, ItemCount iOffsetCount, ByteOffset iOffsetArray[2147483647], ItemCount *oOffsetCount, ByteOffset oOffsetArray[2147483647], ByteCount iOutputBufLen, ByteCount *oSourceRead, ByteCount *oUnicodeLen, UniCharArrayPtr oUnicodeStr)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ConvertFromTextToUnicode
    ENDIF

;
; pascal OSStatus ConvertFromUnicodeToText(UnicodeToTextInfo iUnicodeToTextInfo, ByteCount iUnicodeLen, ConstUniCharArrayPtr iUnicodeStr, OptionBits iControlFlags, ItemCount iOffsetCount, ByteOffset iOffsetArray[2147483647], ItemCount *oOffsetCount, ByteOffset oOffsetArray[2147483647], ByteCount iOutputBufLen, ByteCount *oInputRead, ByteCount *oOutputLen, LogicalAddress oOutputStr)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ConvertFromUnicodeToText
    ENDIF

;
; pascal OSStatus ConvertFromUnicodeToTextRun(UnicodeToTextRunInfo iUnicodeToTextInfo, ByteCount iUnicodeLen, ConstUniCharArrayPtr iUnicodeStr, OptionBits iControlFlags, ItemCount iOffsetCount, ByteOffset iOffsetArray[2147483647], ItemCount *oOffsetCount, ByteOffset oOffsetArray[2147483647], ByteCount iOutputBufLen, ByteCount *oInputRead, ByteCount *oOutputLen, LogicalAddress oOutputStr, ItemCount iEncodingRunBufLen, ItemCount *oEncodingRunOutLen, TextEncodingRun oEncodingRuns[2147483647])
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ConvertFromUnicodeToTextRun
    ENDIF

;
; pascal OSStatus ConvertFromUnicodeToScriptCodeRun(UnicodeToTextRunInfo iUnicodeToTextInfo, ByteCount iUnicodeLen, ConstUniCharArrayPtr iUnicodeStr, OptionBits iControlFlags, ItemCount iOffsetCount, ByteOffset iOffsetArray[2147483647], ItemCount *oOffsetCount, ByteOffset oOffsetArray[2147483647], ByteCount iOutputBufLen, ByteCount *oInputRead, ByteCount *oOutputLen, LogicalAddress oOutputStr, ItemCount iScriptRunBufLen, ItemCount *oScriptRunOutLen, ScriptCodeRun oScriptCodeRuns[2147483647])
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ConvertFromUnicodeToScriptCodeRun
    ENDIF

;  Truncate a multibyte string at a safe place.
;
; pascal OSStatus TruncateForTextToUnicode(ConstTextToUnicodeInfo iTextToUnicodeInfo, ByteCount iSourceLen, ConstLogicalAddress iSourceStr, ByteCount iMaxLen, ByteCount *oTruncatedLen)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION TruncateForTextToUnicode
    ENDIF

;  Truncate a Unicode string at a safe place.
;
; pascal OSStatus TruncateForUnicodeToText(ConstUnicodeToTextInfo iUnicodeToTextInfo, ByteCount iSourceLen, ConstUniCharArrayPtr iSourceStr, OptionBits iControlFlags, ByteCount iMaxLen, ByteCount *oTruncatedLen)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION TruncateForUnicodeToText
    ENDIF

;  Convert a Pascal string to Unicode string.
;
; pascal OSStatus ConvertFromPStringToUnicode(TextToUnicodeInfo iTextToUnicodeInfo, ConstStr255Param iPascalStr, ByteCount iOutputBufLen, ByteCount *oUnicodeLen, UniCharArrayPtr oUnicodeStr)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ConvertFromPStringToUnicode
    ENDIF

;  Convert a Unicode string to Pascal string.
;
; pascal OSStatus ConvertFromUnicodeToPString(UnicodeToTextInfo iUnicodeToTextInfo, ByteCount iUnicodeLen, ConstUniCharArrayPtr iUnicodeStr, Str255 oPascalStr)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION ConvertFromUnicodeToPString
    ENDIF

;  Count the available conversion mappings.
;
; pascal OSStatus CountUnicodeMappings(OptionBits iFilter, ConstUnicodeMappingPtr iFindMapping, ItemCount *oActualCount)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION CountUnicodeMappings
    ENDIF

;  Get a list of the available conversion mappings.
;
; pascal OSStatus QueryUnicodeMappings(OptionBits iFilter, ConstUnicodeMappingPtr iFindMapping, ItemCount iMaxCount, ItemCount *oActualCount, UnicodeMapping oReturnedMappings[2147483647])
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION QueryUnicodeMappings
    ENDIF

;  Setup the fallback handler for converting Unicode To Text.
;
; pascal OSStatus SetFallbackUnicodeToText(UnicodeToTextInfo iUnicodeToTextInfo, UnicodeToTextFallbackUPP iFallback, OptionBits iControlFlags, LogicalAddress iInfoPtr)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION SetFallbackUnicodeToText
    ENDIF

;  Setup the fallback handler for converting Unicode To TextRuns.
;
; pascal OSStatus SetFallbackUnicodeToTextRun(UnicodeToTextRunInfo iUnicodeToTextRunInfo, UnicodeToTextFallbackUPP iFallback, OptionBits iControlFlags, LogicalAddress iInfoPtr)
;
    IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
        IMPORT_CFM_FUNCTION SetFallbackUnicodeToTextRun
    ENDIF


    ENDIF ; __UNICODECONVERTER__